/*
 * Copyright (c) 2011 Justin Holewinski
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#if !defined(RVM_ENGINE_VMENGINE_HPP_INC)
#define RVM_ENGINE_VMENGINE_HPP_INC 1

namespace rvm
{
namespace engine
{

/**
 * Execution context for the Rapture Virtual Machine.
 *
 * This class controls all aspects of the RVM run-time system.  Client
 * applications must create an object of this class before using any other
 * classes in the RVM engine library, as most support classes require an
 * instance of this class.
 */
class VMEngine
{
public:

  /**
   * Constructor.
   */
  VMEngine();

  /**
   * Destructor.
   */
  virtual ~VMEngine();


  /**
   * @{
   * \name Logging
   */

  /**
   * Enables/disables writing log information to the system console.
   *
   * @param[in] enable  True to enable, false to disable.
   */
  virtual void SetLogToConsole(bool enable = true);

  /**
   * @}
   */


private:

  bool writeToConsole_;
  
};

}
}

#endif
